<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Transformer (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Transformer (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Transformer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/RankingModel.html" title="interface in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/Transformer.html" target="_top">Frames</a></li>
<li><a href="Transformer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.ranking.api</div>
<h2 title="Interface Transformer" class="title">Interface Transformer&lt;Target&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">Transformer&lt;Target&gt;</span></pre>
<div class="block">Transformers role is to transform nodes/edges numerical attributes 
 to visual signs (e.g. color or sizes). It uses a normalized real number
 between zero and one to output a meaningful value.
 <p>
 Transformers can be applied to a subset of values using lower/bound filter
 values.
 <p>
 Default transformers implemented in the RankingPlugin:
 <ul><li><b>RENDERABLE_COLOR:</b> Sets node/edge color</li>
 <li><b>RENDERABLE_SIZE:</b> Sets node/edge size. For edges, the size is the weight.</li>
 <li><b>LABEL_COLOR:</b> Sets label color.</li>
 <li><b>LABEL_SIZE:</b> Sets label size. Note this is a multiplier.</li></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api"><code>Ranking</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#LABEL_COLOR">LABEL_COLOR</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#LABEL_SIZE">LABEL_SIZE</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#RENDERABLE_COLOR">RENDERABLE_COLOR</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#RENDERABLE_SIZE">RENDERABLE_SIZE</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#getLowerBound()">getLowerBound</a></strong>()</code>
<div class="block">Returns the lower bound filter value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#getUpperBound()">getUpperBound</a></strong>()</code>
<div class="block">Returns the upper bound filter value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#isInBounds(float)">isInBounds</a></strong>(float&nbsp;value)</code>
<div class="block">Returns <code>true</code> if <code>value</code> is within the lower and
 the upper bound.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#setLowerBound(float)">setLowerBound</a></strong>(float&nbsp;lowerBound)</code>
<div class="block">Sets the lower filter bound.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#setUpperBound(float)">setUpperBound</a></strong>(float&nbsp;upperBound)</code>
<div class="block">Sets the upper filter bound.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/Transformer.html#transform(Target, float)">transform</a></strong>(<a href="../../../../org/gephi/ranking/api/Transformer.html" title="type parameter in Transformer">Target</a>&nbsp;target,
         float&nbsp;normalizedValue)</code>
<div class="block">Transforms <code>target</code> with <code>normalizedValue</code> between
 zero and one.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="RENDERABLE_COLOR">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RENDERABLE_COLOR</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RENDERABLE_COLOR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Transformer.RENDERABLE_COLOR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="RENDERABLE_SIZE">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RENDERABLE_SIZE</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RENDERABLE_SIZE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Transformer.RENDERABLE_SIZE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LABEL_COLOR">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LABEL_COLOR</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LABEL_COLOR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Transformer.LABEL_COLOR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LABEL_SIZE">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LABEL_SIZE</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LABEL_SIZE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.gephi.ranking.api.Transformer.LABEL_SIZE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setLowerBound(float)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLowerBound</h4>
<pre>void&nbsp;setLowerBound(float&nbsp;lowerBound)</pre>
<div class="block">Sets the lower filter bound. Values lower than this value won't be
 transformed. By default the bound is set to zero, so no filtering.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lowerBound</code> - the lower bound filter value</dd></dl>
</li>
</ul>
<a name="setUpperBound(float)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpperBound</h4>
<pre>void&nbsp;setUpperBound(float&nbsp;upperBound)</pre>
<div class="block">Sets the upper filter bound. Values upper than this value won't be
 transformed. By default the bound is set to one, so no filtering.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>upperBound</code> - the upper bound filter value</dd></dl>
</li>
</ul>
<a name="getLowerBound()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowerBound</h4>
<pre>float&nbsp;getLowerBound()</pre>
<div class="block">Returns the lower bound filter value. By default it's set to zero, so
 filtering is disabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the lower bound filter value</dd></dl>
</li>
</ul>
<a name="getUpperBound()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpperBound</h4>
<pre>float&nbsp;getUpperBound()</pre>
<div class="block">Returns the upper bound filter value. By default it's set to one, so
 filtering is disabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the upper bound filter value</dd></dl>
</li>
</ul>
<a name="isInBounds(float)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInBounds</h4>
<pre>boolean&nbsp;isInBounds(float&nbsp;value)</pre>
<div class="block">Returns <code>true</code> if <code>value</code> is within the lower and
 the upper bound. Typically, this is called before <code>transform()</code>
 to know if a value can be processed. By default, this always returns <code>
 true</code>, as lower bound is set ot zero and upper bound to one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value to test if in bounds</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if value superior or equal to lowerBound and
 value inferior or equal to upperBound, <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="transform(java.lang.Object,float)">
<!--   -->
</a><a name="transform(Target, float)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transform</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;transform(<a href="../../../../org/gephi/ranking/api/Transformer.html" title="type parameter in Transformer">Target</a>&nbsp;target,
               float&nbsp;normalizedValue)</pre>
<div class="block">Transforms <code>target</code> with <code>normalizedValue</code> between
 zero and one. The method also returns the transformed value, like the color
 for instance for a color transformer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the object to transform</dd><dd><code>normalizedValue</code> - the ranking normalized value</dd>
<dt><span class="strong">Returns:</span></dt><dd>the transformed value, or <code>null</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Transformer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/RankingModel.html" title="interface in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/Transformer.html" target="_top">Frames</a></li>
<li><a href="Transformer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
